Chat Support
Loupe - Log - Monitor - Resolve
Gibraltar.Agent Namespace / Log Class / ErrorDetail Method / ErrorDetail(Exception,Boolean,LogWriteMode,String,String,String,String,Object[]) Method
An Exception object to attach to this log message.
True to record this log message based on where the exception was thrown, not where this method was called
Whether to queue-and-return or wait-for-commit.
An XML document (as a string) with extended details about the message.
The application subsystem or logging category that the log message is associated with, which supports a dot-delimited hierarchy (e.g. the logger name in log4net).
A simple single-line message caption. (Will not be processed for formatting.)
Additional multi-line descriptive message (or may be null) which can be a format string followed by corresponding args.
A variable number of arguments referenced by the formatted description string (or no arguments to skip formatting).

In This Topic
    ErrorDetail(Exception,Boolean,LogWriteMode,String,String,String,String,Object[]) Method
    In This Topic
    Write a detailed Error message directly to the Loupe log with an optional attached Exception and specifying Queued or WaitForCommit behavior.
    Syntax
    'Declaration
     
    
    Public Overloads Shared Sub ErrorDetail( _
       ByVal exception As Exception, _
       ByVal attributeToException As Boolean, _
       ByVal writeMode As LogWriteMode, _
       ByVal detailsXml As String, _
       ByVal category As String, _
       ByVal caption As String, _
       ByVal description As String, _
       ByVal ParamArray args() As Object _
    ) 

    Parameters

    exception
    An Exception object to attach to this log message.
    attributeToException
    True to record this log message based on where the exception was thrown, not where this method was called
    writeMode
    Whether to queue-and-return or wait-for-commit.
    detailsXml
    An XML document (as a string) with extended details about the message.
    category
    The application subsystem or logging category that the log message is associated with, which supports a dot-delimited hierarchy (e.g. the logger name in log4net).
    caption
    A simple single-line message caption. (Will not be processed for formatting.)
    description
    Additional multi-line descriptive message (or may be null) which can be a format string followed by corresponding args.
    args
    A variable number of arguments referenced by the formatted description string (or no arguments to skip formatting).
    Remarks

    This method provides an advanced use of Loupe log messages to include an XML document (as a string) containing extended details about the message.

    This overload also allows an Exception object to be attached to the log message. An Exception-typed null (e.g. from a variable of an Exception type) is allowed for the exception argument, but calls which do not have a possible Exception to attach should use an overload without an exception argument rather than pass a direct value of null, to avoid compiler ambiguity over the type of a simple null.

    If attributeToException is set to true the log message will be attributed to the location where the provided exception was thrown from instead of the caller of this method.

    Requirements

    Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

    See Also